GET /manage/v2/servers/{id|name}

Summary

This resource address returns data about a specific App Server. The server can be identified either by id or name. The data returned depends on the value of the view request parameter. The default view is a summary with links to additional data.

Response

For all views except edit, upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. If view=edit, MarkLogic Server responds with status code 302 (Found) and the Location header contains a redirect to the appropriate configuration page in the Admin Interface.

Required Privileges

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The structure of the returned data for each type of server is shown below.

• HTTP Server
• ODBC Server
• XDBC Server
• Task Server

HTTP Server

The structure of the data in the response for an HTTP server is as follows:

id

An HTTP server id.

name

An HTTP server name.

server-kind

The kind of server, which is either http, task, webDAV, xdbc, or odbc.

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

http-config-properties

The configuration properties of the HTTP server.

This is a complex structure with the following children:

enabled

Appserver enabled status.

root

The root document directory pathname. The module directory root. The module directory root.

port

The server socket bind internet port number.

public-port

Whether the port is accessible from the public internet.

webDAV

webDAV server versus HTTP server.

execute

True if server executes xquery modules.

display-last-login

Indicates whether an appserver should display users' last login information.

address

The server socket bind numeric internet address.

backlog

The socket listen backlog.

threads

The maximum number of server threads allowed on each host in the group; the server may also additionally limit threads.

request-timeout

The request socket recv timeout, in seconds.

keep-alive-timeout

The keep-alive socket recv timeout, in seconds.

session-timeout

The session expiration timeout, in seconds.

max-time-limit

The upper bound for a request's time limit, in seconds.

default-time-limit

The default time limit for a request, in seconds.

max-inference-size

The upper bound for a request's inference size, in megabytes.

default-inference-size

The default inference size for a request, in megabytes.

static-expires

Add an "expires" HTTP header for static content to expire after this many seconds.

pre-commit-trigger-depth

The maximum depth of pre-commit trigger invocation.

pre-commit-trigger-limit

The maximum number of triggers a single statement can invoke.

collation

The default collation for queries.

coordinate-system

The default coordinate system for queries.

authentication

The authentication scheme to use for this server

internal-security

Whether or not the security database is used for authentication and authorization.

external-security

External authentication and authorization configuration.

external-securities

External authentication and authorization configurations.

This is a complex structure with the following children:

external-security

External authentication and authorization configuration.

default-user

The user used as the default user in application level authentication. Using the admin user as the default user is equivalent to turning security off.

privilege

The privilege restricting access to the server.

concurrent-request-limit

The maximum number of concurrent requests per user.

compute-content-length

Compute content lengths for webDAV.

file-log-level

The minimum log level for log messages in the log file.

opsdirector-applog-level

DEPRECATED

log-errors

Log uncaught request processing errors to ErrorLog.txt.

debug-allow

Allow debugging on this server.

profile-allow

Allow profiling on this server.

default-xquery-version

The default XQuery language version for this server.

multi-version-concurrency-control

Specifies concurrency control of read-only queries.

distribute-timestamps

Specifies the distribution of commit timestamps after updates.

output-sgml-character-entities

Output SGML character entities.

output-encoding

The default output encoding.

output-method

Output method.

output-byte-order-mark

The output sequence of octets is to be preceded by a Byte Order Mark.

output-cdata-section-namespace-uri

Namespace URI of the "cdata section localname" specified below.

output-cdata-section-localname

Element localname or list of element localnames to be output as CDATA sections.

output-doctype-public

A public identifier to use on the emitted DOCTYPE.

output-doctype-system

A system identifier to use on the emitted DOCTYPE.

output-escape-uri-attributes

Apply Unicode normalization, percent-encoding, and HTML escaping to serialized URI attributes.

output-include-content-type

Include the content-type declaration when serializing the node.

output-indent

Pretty-print typed XML (that is, XML for which there is an in-scope schema).

output-indent-untyped

Pretty-print untyped XML (that is, XML for which there is no in-scope schema).

output-indent-tabs

Output a tab character instead of 8 consecutive spaces when indenting.

output-media-type

A mimetype representing a media type.

output-normalization-form

A Unicode normalization to be applied to serialized output.

output-omit-xml-declaration

Omit the XML declaration in serialized output.

output-standalone

For a value of "yes" or "no", include "standalone=<value>" in the XML declaration; for a value of "omit", omit "standalone=".

output-undeclare-prefixes

Undeclare the namespace prefix of any child element that does not bind the prefix of its parent element.

output-version

Optionally stipulate conformance to a specific version of the output method.

output-include-default-attributes

Specifies whether attributes defaulted with a schema should be included in the serialization.

default-error-format

The default error format for protocol errors. One of html,xml,json,compatiable

error-handler

The script that handles 400 and 500 errors for this server.

schemas

The schema binding specifications.

This is a complex structure with the following children:

schema

A schema binding specification.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

schema-location

A schema location.

namespaces

The namespace binding specifications.

This is a complex structure with the following children:

namespace

A namespace binding specification.

This is a complex structure with the following children:

prefix

A QName prefix.

namespace-uri

A namespace URI.

using-namespace

A namespace path URI.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

module-locations

The module location specifications.

This is a complex structure with the following children:

module-location

A module location specification.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

location

A module location.

request-blackouts

Users, roles, or periods during which requests will be denied.

This is a complex structure with the following children:

request-blackout

A request blackout specification.

This is a complex structure with the following children:

users

The users that this blackout is active for.

roles

The roles that this blackout is active for.

blackout-type

What type of blackout is this.

days

The days that this blackout is active.

This is a complex structure with the following children:

day

A day that this blackout is active.

period

A period, which is all day, a start time and a duration, or a start and end time.

This is a complex structure with the following children:

start-date

The starting date (in MM/DD/YYYY notation)

start-time

The starting time (in 24:00 notation).

end-date

The ending date (in MM/DD/YYYY notation)

end-time

The ending time (in 24:00 notation).

duration

The duration, specifed as hours:minutes (i.e. 2 hours 5 minutes is 2:05)

url-rewriter

The script that rewrites URLs for this server.

rewrite-resolves-globally

Allow rewritten URLs to be resolved from the global MarkLogic Modules/ directory.

ssl-certificate-template

The certificate template. When a certificate template is specified, the App Server uses an SSL encrypted protocol (e.g. https, davs, xccs). The certificate template specifies the common information for the individual SSL certificates needed for each host in the group.

You can add a new certificate template by navigating to Security > Certificate Templates > Create

ssl-allow-sslv3

Whether or not SSLv3 is allowed.

ssl-allow-tls

Whether or not TLS is allowed.

ssl-disable-sslv3

Whether or not ssl v3 is disable.

ssl-disable-tlsv1

Whether or not TLS v1 is disable.

ssl-disable-tlsv1-1

Whether or not TLS v1 is disable.

ssl-disable-tlsv1-2

Whether or not TLS v1 is disable.

ssl-hostname

The host name for the server's SSL certificate. This is useful when many servers are running behind a load balancer. If not specified, each host will use a certificate specifying its own hostname. Note that per RFC 2459, hostnames must not exceed 64 characters in length.

ssl-ciphers

A colon separated list of ciphers (e.g. ALL:!LOW:@STRENGTH)

ssl-require-client-certificate

Whether or not a client certificate is required. This only has an effect when one or more client certificate authorities are specified (including the client certificate authorities in the external securities), in which case a value of true will refuse a client request if it does not present a valid client certificate.

ssl-client-issuer-authority-verification

Accept client certificates only if the issuer is one of the selected CAs in the 'ssl client certificate authorities' list below.

ssl-client-certificate-authorities

Certificate authorities that may sign client certificates for this server. Selecting one or more certificate authorities when SSL is enabled will require all clients to present a valid certificate signed by one of the selected authorities. Clicking on an organization below will reveal the certificate authorities for that organization.

This is a complex structure with the following children:

ssl-client-certificate-authority

An SSL certificate authority

enable-hsts-header

Whether or not to include HSTS header in HTTPS response.

hsts-header-max-age

The max-age field of HSTS header

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

ODBC Server

The structure of the data in the response for an ODBC server is as follows:

id

An HTTP server id.

name

An HTTP server name.

server-kind

The kind of server, which is either http, task, webDAV, xdbc, or odbc.

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

odbc-config-properties

The configuration properties of the ODBC server.

This is a complex structure with the following children:

enabled

Appserver enabled status.

root

The root document directory pathname. The module directory root. The module directory root.

port

The server socket bind internet port number.

public-port

Whether the port is accessible from the public internet.

display-last-login

Indicates whether an appserver should display users' last login information.

address

The server socket bind numeric internet address.

backlog

The socket listen backlog.

threads

The maximum number of server threads allowed on each host in the group; the server may also additionally limit threads.

connection-timeout

The idle connection expiration timeout, in seconds, or 0 to indicate no idle connection timeout.

max-query-time-limit

The upper bound for a query's time limit, in seconds.

default-query-time-limit

The default time limit for a query, in seconds.

pre-commit-trigger-depth

The maximum depth of pre-commit trigger invocation.

pre-commit-trigger-limit

The maximum number of triggers a single statement can invoke.

collation

The default collation for queries.

coordinate-system

The default coordinate system for queries.

authentication

The authentication scheme to use for this server

internal-security

Whether or not the security database is used for authentication and authorization.

external-security

External authentication and authorization configuration.

external-securities

External authentication and authorization configurations.

This is a complex structure with the following children:

external-security

External authentication and authorization configuration.

privilege

The privilege restricting access to the server.

concurrent-request-limit

The maximum number of concurrent requests per user.

file-log-level

The minimum log level for log messages in the log file.

opsdirector-applog-level

DEPRECATED

log-errors

Log uncaught request processing errors to ErrorLog.txt.

debug-allow

Allow debugging on this server.

profile-allow

Allow profiling on this server.

default-xquery-version

The default XQuery language version for this server.

multi-version-concurrency-control

Specifies concurrency control of read-only queries.

distribute-timestamps

Specifies the distribution of commit timestamps after updates.

output-sgml-character-entities

Output SGML character entities.

output-encoding

The default output encoding.

output-method

Output method.

output-byte-order-mark

The output sequence of octets is to be preceded by a Byte Order Mark.

output-cdata-section-namespace-uri

Namespace URI of the "cdata section localname" specified below.

output-cdata-section-localname

Element localname or list of element localnames to be output as CDATA sections.

output-doctype-public

A public identifier to use on the emitted DOCTYPE.

output-doctype-system

A system identifier to use on the emitted DOCTYPE.

output-escape-uri-attributes

Apply Unicode normalization, percent-encoding, and HTML escaping to serialized URI attributes.

output-include-content-type

Include the content-type declaration when serializing the node.

output-indent

Pretty-print typed XML (that is, XML for which there is an in-scope schema).

output-indent-untyped

Pretty-print untyped XML (that is, XML for which there is no in-scope schema).

output-indent-tabs

Output a tab character instead of 8 consecutive spaces when indenting.

output-media-type

A mimetype representing a media type.

output-normalization-form

A Unicode normalization to be applied to serialized output.

output-omit-xml-declaration

Omit the XML declaration in serialized output.

output-standalone

For a value of "yes" or "no", include "standalone=<value>" in the XML declaration; for a value of "omit", omit "standalone=".

output-undeclare-prefixes

Undeclare the namespace prefix of any child element that does not bind the prefix of its parent element.

output-version

Optionally stipulate conformance to a specific version of the output method.

output-include-default-attributes

Specifies whether attributes defaulted with a schema should be included in the serialization.

schemas

The schema binding specifications.

This is a complex structure with the following children:

schema

A schema binding specification.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

schema-location

A schema location.

namespaces

The namespace binding specifications.

This is a complex structure with the following children:

namespace

A namespace binding specification.

This is a complex structure with the following children:

prefix

A QName prefix.

namespace-uri

A namespace URI.

using-namespace

A namespace path URI.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

module-locations

The module location specifications.

This is a complex structure with the following children:

module-location

A module location specification.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

location

A module location.

request-blackouts

Users, roles, or periods during which requests will be denied.

This is a complex structure with the following children:

request-blackout

A request blackout specification.

This is a complex structure with the following children:

users

The users that this blackout is active for.

roles

The roles that this blackout is active for.

blackout-type

What type of blackout is this.

days

The days that this blackout is active.

This is a complex structure with the following children:

day

A day that this blackout is active.

period

A period, which is all day, a start time and a duration, or a start and end time.

This is a complex structure with the following children:

start-date

The starting date (in MM/DD/YYYY notation)

start-time

The starting time (in 24:00 notation).

end-date

The ending date (in MM/DD/YYYY notation)

end-time

The ending time (in 24:00 notation).

duration

The duration, specifed as hours:minutes (i.e. 2 hours 5 minutes is 2:05)

ssl-certificate-template

The certificate template. When a certificate template is specified, the App Server uses an SSL encrypted protocol (e.g. https, davs, xccs). The certificate template specifies the common information for the individual SSL certificates needed for each host in the group.

You can add a new certificate template by navigating to Security > Certificate Templates > Create

ssl-allow-sslv3

Whether or not SSLv3 is allowed.

ssl-allow-tls

Whether or not TLS is allowed.

ssl-disable-sslv3

Whether or not ssl v3 is disable.

ssl-disable-tlsv1

Whether or not TLS v1 is disable.

ssl-disable-tlsv1-1

Whether or not TLS v1 is disable.

ssl-disable-tlsv1-2

Whether or not TLS v1 is disable.

ssl-hostname

The host name for the server's SSL certificate. This is useful when many servers are running behind a load balancer. If not specified, each host will use a certificate specifying its own hostname. Note that per RFC 2459, hostnames must not exceed 64 characters in length.

ssl-ciphers

A colon separated list of ciphers (e.g. ALL:!LOW:@STRENGTH)

ssl-require-client-certificate

Whether or not a client certificate is required. This only has an effect when one or more client certificate authorities are specified (including the client certificate authorities in the external securities), in which case a value of true will refuse a client request if it does not present a valid client certificate.

ssl-client-issuer-authority-verification

Accept client certificates only if the issuer is one of the selected CAs in the 'ssl client certificate authorities' list below.

ssl-client-certificate-authorities

Certificate authorities that may sign client certificates for this server. Selecting one or more certificate authorities when SSL is enabled will require all clients to present a valid certificate signed by one of the selected authorities. Clicking on an organization below will reveal the certificate authorities for that organization.

This is a complex structure with the following children:

ssl-client-certificate-authority

An SSL certificate authority

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

XDBC Server

The structure of the data in the response for an XDBC server is as follows:

id

An HTTP server id.

name

An HTTP server name.

server-kind

The kind of server, which is either http, task, webDAV, xdbc, or odbc.

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

xdbc-config-properties

The configuration properties of the XDBC server.

This is a complex structure with the following children:

enabled

Appserver enabled status.

root

The root document directory pathname. The module directory root. The module directory root.

port

The server socket bind internet port number.

public-port

Whether the port is accessible from the public internet.

display-last-login

Indicates whether an appserver should display users' last login information.

address

The server socket bind numeric internet address.

backlog

The socket listen backlog.

threads

The maximum number of server threads allowed on each host in the group; the server may also additionally limit threads.

request-timeout

The request socket recv timeout, in seconds.

keep-alive-timeout

The keep-alive socket recv timeout, in seconds.

session-timeout

The session expiration timeout, in seconds.

max-time-limit

The upper bound for a request's time limit, in seconds.

default-time-limit

The default time limit for a request, in seconds.

max-inference-size

The upper bound for a request's inference size, in megabytes.

default-inference-size

The default inference size for a request, in megabytes.

pre-commit-trigger-depth

The maximum depth of pre-commit trigger invocation.

pre-commit-trigger-limit

The maximum number of triggers a single statement can invoke.

collation

The default collation for queries.

coordinate-system

The default coordinate system for queries.

authentication

The authentication scheme to use for this server

internal-security

Whether or not the security database is used for authentication and authorization.

external-security

External authentication and authorization configuration.

external-securities

External authentication and authorization configurations.

This is a complex structure with the following children:

external-security

External authentication and authorization configuration.

privilege

The privilege restricting access to the server.

concurrent-request-limit

The maximum number of concurrent requests per user.

file-log-level

The minimum log level for log messages in the log file.

opsdirector-applog-level

DEPRECATED

log-errors

Log uncaught request processing errors to ErrorLog.txt.

debug-allow

Allow debugging on this server.

profile-allow

Allow profiling on this server.

default-xquery-version

The default XQuery language version for this server.

multi-version-concurrency-control

Specifies concurrency control of read-only queries.

distribute-timestamps

Specifies the distribution of commit timestamps after updates.

output-sgml-character-entities

Output SGML character entities.

output-encoding

The default output encoding.

output-method

Output method.

output-byte-order-mark

The output sequence of octets is to be preceded by a Byte Order Mark.

output-cdata-section-namespace-uri

Namespace URI of the "cdata section localname" specified below.

output-cdata-section-localname

Element localname or list of element localnames to be output as CDATA sections.

output-doctype-public

A public identifier to use on the emitted DOCTYPE.

output-doctype-system

A system identifier to use on the emitted DOCTYPE.

output-escape-uri-attributes

Apply Unicode normalization, percent-encoding, and HTML escaping to serialized URI attributes.

output-include-content-type

Include the content-type declaration when serializing the node.

output-indent

Pretty-print typed XML (that is, XML for which there is an in-scope schema).

output-indent-untyped

Pretty-print untyped XML (that is, XML for which there is no in-scope schema).

output-indent-tabs

Output a tab character instead of 8 consecutive spaces when indenting.

output-media-type

A mimetype representing a media type.

output-normalization-form

A Unicode normalization to be applied to serialized output.

output-omit-xml-declaration

Omit the XML declaration in serialized output.

output-standalone

For a value of "yes" or "no", include "standalone=<value>" in the XML declaration; for a value of "omit", omit "standalone=".

output-undeclare-prefixes

Undeclare the namespace prefix of any child element that does not bind the prefix of its parent element.

output-version

Optionally stipulate conformance to a specific version of the output method.

output-include-default-attributes

Specifies whether attributes defaulted with a schema should be included in the serialization.

schemas

The schema binding specifications.

This is a complex structure with the following children:

schema

A schema binding specification.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

schema-location

A schema location.

namespaces

The namespace binding specifications.

This is a complex structure with the following children:

namespace

A namespace binding specification.

This is a complex structure with the following children:

prefix

A QName prefix.

namespace-uri

A namespace URI.

using-namespace

A namespace path URI.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

module-locations

The module location specifications.

This is a complex structure with the following children:

module-location

A module location specification.

This is a complex structure with the following children:

namespace-uri

A namespace URI.

location

A module location.

request-blackouts

Users, roles, or periods during which requests will be denied.

This is a complex structure with the following children:

request-blackout

A request blackout specification.

This is a complex structure with the following children:

users

The users that this blackout is active for.

roles

The roles that this blackout is active for.

blackout-type

What type of blackout is this.

days

The days that this blackout is active.

This is a complex structure with the following children:

day

A day that this blackout is active.

period

A period, which is all day, a start time and a duration, or a start and end time.

This is a complex structure with the following children:

start-date

The starting date (in MM/DD/YYYY notation)

start-time

The starting time (in 24:00 notation).

end-date

The ending date (in MM/DD/YYYY notation)

end-time

The ending time (in 24:00 notation).

duration

The duration, specifed as hours:minutes (i.e. 2 hours 5 minutes is 2:05)

ssl-certificate-template

The certificate template. When a certificate template is specified, the App Server uses an SSL encrypted protocol (e.g. https, davs, xccs). The certificate template specifies the common information for the individual SSL certificates needed for each host in the group.

You can add a new certificate template by navigating to Security > Certificate Templates > Create

ssl-allow-sslv3

Whether or not SSLv3 is allowed.

ssl-allow-tls

Whether or not TLS is allowed.

ssl-disable-sslv3

Whether or not ssl v3 is disable.

ssl-disable-tlsv1

Whether or not TLS v1 is disable.

ssl-disable-tlsv1-1

Whether or not TLS v1 is disable.

ssl-disable-tlsv1-2

Whether or not TLS v1 is disable.

ssl-hostname

The host name for the server's SSL certificate. This is useful when many servers are running behind a load balancer. If not specified, each host will use a certificate specifying its own hostname. Note that per RFC 2459, hostnames must not exceed 64 characters in length.

ssl-ciphers

A colon separated list of ciphers (e.g. ALL:!LOW:@STRENGTH)

ssl-require-client-certificate

Whether or not a client certificate is required. This only has an effect when one or more client certificate authorities are specified (including the client certificate authorities in the external securities), in which case a value of true will refuse a client request if it does not present a valid client certificate.

ssl-client-issuer-authority-verification

Accept client certificates only if the issuer is one of the selected CAs in the 'ssl client certificate authorities' list below.

ssl-client-certificate-authorities

Certificate authorities that may sign client certificates for this server. Selecting one or more certificate authorities when SSL is enabled will require all clients to present a valid certificate signed by one of the selected authorities. Clicking on an organization below will reveal the certificate authorities for that organization.

This is a complex structure with the following children:

ssl-client-certificate-authority

An SSL certificate authority

enable-hsts-header

Whether or not to include HSTS header in HTTPS response.

hsts-header-max-age

The max-age field of HSTS header

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Task Server

The structure of the data in the response for a Task server is as follows:

id

An HTTP server id.

name

An HTTP server name.

server-kind

The kind of server, which is either http, task, webDAV, xdbc, or odbc.

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

task-config-properties

The configuration characteristics of the task server.

This is a complex structure with the following children:

threads

The maximum number of server threads allowed on each host in the group; the server may also additionally limit threads.

debug-threads

The maximum number of debugging threads allowed on each host in the group.

max-time-limit

The upper bound for a request's time limit, in seconds.

default-time-limit

The default time limit for a request, in seconds.

max-inference-size

The upper bound for a request's inference size, in megabytes.

default-inference-size

The default inference size for a request, in megabytes.

queue-size

The maximum number of tasks allowed.

pre-commit-trigger-depth

The maximum depth of pre-commit trigger invocation.

post-commit-trigger-depth

The maximum depth of post-commit trigger invocation.

pre-commit-trigger-limit

The maximum number of triggers a single statement can invoke.

file-log-level

The minimum log level for log messages in the log file.

opsdirector-applog-level

DEPRECATED

log-errors

Log uncaught request processing errors to ErrorLog.txt.

debug-allow

Allow debugging on this server.

profile-allow

Allow profiling on this server.

scheduled-tasks

The scheduled tasks' specifications.

This is a complex structure with the following children:

scheduled-task

A scheduled task specification.

This is a complex structure with the following children:

scheduled-task-relations

The relations of the scheduled task.

This is a complex structure with the following children:

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

relation-id

A group or host related to the server.

task-id

The task ID.

task-enabled

Whether or not a task is enabled

task-path

The module to invoke.

task-root

The path to the module directory root.

task-type

What type of scheduled task is this.

task-period

How often this task should run (every n months, weeks, days, hours or minutes).

task-month-day

The day of the month that this task runs on.

task-days

The days that this task runs on.

This is a complex structure with the following children:

task-day

A day that this task runs on.

task-start-date

The starting date (in MM/DD/YYYY notation) for this task.

task-start-time

The starting time (in 24:00 notation) for this task.

task-timestamp

The date and time this task was created.

task-user

The user to run this task as.

task-priority

The priority of this task.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example

http://localhost:8002/manage/v2/servers/Admin?group-id=Default

==>  Returns information on the Admin server in the Default group. 
    

Example

http://localhost:8002/manage/v2/servers/Admin?group-id=Default&view=status

==>  Returns the status of the Admin server in the Default group.